generated from oracle/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 65
[CHORE] Best practices doc #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
f15418d to
2bc9c5d
Compare
gebhardtr
reviewed
Oct 24, 2025
gebhardtr
reviewed
Oct 24, 2025
gebhardtr
reviewed
Oct 24, 2025
shopewf
commented
Oct 24, 2025
9b36b5e to
2d28d93
Compare
gebhardtr
reviewed
Oct 28, 2025
gebhardtr
reviewed
Oct 28, 2025
6b05fb2 to
89992b2
Compare
cboffa13
approved these changes
Oct 28, 2025
irfan-ahmed
approved these changes
Oct 28, 2025
153778b to
d8abbc3
Compare
This was referenced Oct 29, 2025
cboffa13
reviewed
Oct 30, 2025
076b9e2 to
db81704
Compare
gebhardtr
reviewed
Oct 30, 2025
gebhardtr
reviewed
Oct 30, 2025
db81704 to
9ab9a2f
Compare
gebhardtr
previously approved these changes
Oct 30, 2025
Signed-off-by: will.shope <[email protected]>
9ab9a2f to
eb24f13
Compare
gebhardtr
approved these changes
Oct 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The changes in this PR include a new best practices doc to explain a few of our general design guidelines.
Note: The changes in this PR are not currently all-encompassing, meaning once this gets reviewed and people like it, then I can apply those best practices to the rest of the repo. I dont want to do that first, then realize people dont like these changes and have to undo/redo them.
There are many small miscellaneous changes as well:
--dataflag, which would then cause the query to fail. It would fail a few more times afterward before it would call the help tool, and then get the query correct. I wanted to avoid that frustration, so I asked it to avoid those complex query flags, and if it needed them to first call the help tool so it didnt get things wrong multiple times in a rowPlease test this with mcphost as well, not just Cline
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Checklist: